Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.93%. Comparing base (c1f17f6) to head (9a44ff5).

@@            Coverage Diff             @@
##           master     #585      +/-   ##
==========================================
- Coverage   89.38%   86.93%   -2.46%     
==========================================
  Files          22       22              
  Lines        1997     1997              
==========================================
- Hits         1785     1736      -49     
- Misses        212      261      +49     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

I use the local builds myself frequently to test docs. So I think it needs to function in each individual repo, which means copying this file everywhere.

I'll also say that IMO a better approach would be to modify autoclass and automodule etc. The advantage there is we could choose to do it in line rather than creating a new nested file each time. I understand that might be more complex though.

I also think we could use vanilla autoclass and automodule for now. We would lose the nice TOCs at the top but we would be able to keep the autogeneration. That might be an intermediate step between what we have and this. One that would allow us to get more comfy with the templates.

Also, we discovered in the dwave-optimization PR that this approach doesn't handle aliases. Which seems like it may be a problem. 🤷

I also think we could use vanilla autoclass and automodule for now. We would lose the nice TOCs at the top but we would be able to keep the autogeneration.

Note that if you try the autosummary directive at the module or class levels with the existing templates you do not get documentation for the underlying properties & methods. (At the module level you also get our current module filenames as the links, which is not ideal.)

Without some updates to templates or code (changing the sphinx autosummary code is not simple at all) the best we can do, as far as I can tell, is to use the default autoclass directive with the :members: option. That gets us all the methods & properties but where there are many it is less easy to scan through. Please see Samplers page and Composites page rendered HTML examples (and compare to this PR's samplers page).

Let me know what you think. I do think our top priority is missed functions. If the rendering shown above is acceptable as a automated-docs halfhouse, might be worth a PR for the upcoming SDK.